﻿/* ==============================================================================
*
*   Copyright (c) 2010, Pierre Favier
*   All rights reserved.
*
*   NTasking is free software: you can redistribute it and/or modify it
*   under the terms of the GNU General Public License as published by the
*   Free Software Foundation.
*
*   Redistribution and use in source and binary forms, with or without
*   modification, are permitted provided that the following conditions
*   are met:
*
*   -   Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*
*   -   Redistributions in binary form must reproduce the above
*       copyright notice, this list of conditions and the following
*       disclaimer in the documentation and/or other materials
*       provided with the distribution.
*
*   THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
*   WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
*   BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
*   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
*   TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
*   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
*   ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
*   TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
*   THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*   SUCH DAMAGE.
*
* ============================================================================== */

using System;

namespace NTasking.Internals
{

    /// <summary>
    /// The <see cref="IExecutable"/> interface defines the methods and properties common to all
    /// objects which can be executed (i.e. entries/entry family members)
    /// </summary>
    internal interface IExecutable : ISynchronizable
    {

        /// <summary>
        /// Gets or sets a delegate which can be used to create an <see cref="ExecutionContext"/> representing
        /// an execution of the current instance.
        /// </summary>
        /// <value>A delegate which can be used to create an <see cref="ExecutionContext"/>.</value>
        Func<ExecutionContext> CreateContext { get; }

    }


    /// <summary>
    /// The <see cref="IExecutable{ExecuteDelegateT}"/> interface defines the methods and properties
    /// common to all objects which can be executed with a given parameter profile.
    /// </summary>
    /// <typeparam name="ExecuteDelegateT">A delegate type representing the profile of the accept's body.</typeparam>
    // ReSharper disable UnusedTypeParameter
    internal interface IExecutable<ExecuteDelegateT> : IExecutable
    // ReSharper restore UnusedTypeParameter
    {

        /// <summary>
        /// Gets or sets the method used as a protected operation's body.
        /// </summary>
        /// <value>The protected operation's body.</value>
        ExecuteDelegateT ProtectedBody { get; set; }

    }


    /// <summary>
    /// The <see cref="IExecutable{RetT, ExecuteDelegateT}"/> interface defines the methods and properties
    /// common to all objects which can be executed with a given parameter profile.
    /// </summary>
    /// <typeparam name="ExecuteDelegateT">A delegate type representing the profile of the accept's body.</typeparam>
    /// <typeparam name="RetT">The method's return type</typeparam>
    // ReSharper disable UnusedTypeParameter
    internal interface IExecutable<RetT, ExecuteDelegateT> : IExecutable<ExecuteDelegateT>
    // ReSharper restore UnusedTypeParameter
    {

        /// <summary>
        /// Executes the specified method body with the specified context.
        /// </summary>
        /// <param name="context">The context containing the call parameters and result.</param>
        /// <param name="body">The method's body.</param>
        /// <returns></returns>
        RetT Execute(CallContext context, ExecuteDelegateT body);

    }

}
